/*! \file bcmecmp_dev.c
 *
 * This file contains device ECMP initialization and cleanup functions.
 */
/*
 * Copyright: (c) 2018 Broadcom. All Rights Reserved. "Broadcom" refers to 
 * Broadcom Limited and/or its subsidiaries.
 * 
 * Broadcom Switch Software License
 * 
 * This license governs the use of the accompanying Broadcom software. Your 
 * use of the software indicates your acceptance of the terms and conditions 
 * of this license. If you do not agree to the terms and conditions of this 
 * license, do not use the software.
 * 1. Definitions
 *    "Licensor" means any person or entity that distributes its Work.
 *    "Software" means the original work of authorship made available under 
 *    this license.
 *    "Work" means the Software and any additions to or derivative works of 
 *    the Software that are made available under this license.
 *    The terms "reproduce," "reproduction," "derivative works," and 
 *    "distribution" have the meaning as provided under U.S. copyright law.
 *    Works, including the Software, are "made available" under this license 
 *    by including in or with the Work either (a) a copyright notice 
 *    referencing the applicability of this license to the Work, or (b) a copy 
 *    of this license.
 * 2. Grant of Copyright License
 *    Subject to the terms and conditions of this license, each Licensor 
 *    grants to you a perpetual, worldwide, non-exclusive, and royalty-free 
 *    copyright license to reproduce, prepare derivative works of, publicly 
 *    display, publicly perform, sublicense and distribute its Work and any 
 *    resulting derivative works in any form.
 * 3. Grant of Patent License
 *    Subject to the terms and conditions of this license, each Licensor 
 *    grants to you a perpetual, worldwide, non-exclusive, and royalty-free 
 *    patent license to make, have made, use, offer to sell, sell, import, and 
 *    otherwise transfer its Work, in whole or in part. This patent license 
 *    applies only to the patent claims licensable by Licensor that would be 
 *    infringed by Licensor's Work (or portion thereof) individually and 
 *    excluding any combinations with any other materials or technology.
 *    If you institute patent litigation against any Licensor (including a 
 *    cross-claim or counterclaim in a lawsuit) to enforce any patents that 
 *    you allege are infringed by any Work, then your patent license from such 
 *    Licensor to the Work shall terminate as of the date such litigation is 
 *    filed.
 * 4. Redistribution
 *    You may reproduce or distribute the Work only if (a) you do so under 
 *    this License, (b) you include a complete copy of this License with your 
 *    distribution, and (c) you retain without modification any copyright, 
 *    patent, trademark, or attribution notices that are present in the Work.
 * 5. Derivative Works
 *    You may specify that additional or different terms apply to the use, 
 *    reproduction, and distribution of your derivative works of the Work 
 *    ("Your Terms") only if (a) Your Terms provide that the limitations of 
 *    Section 7 apply to your derivative works, and (b) you identify the 
 *    specific derivative works that are subject to Your Terms. 
 *    Notwithstanding Your Terms, this license (including the redistribution 
 *    requirements in Section 4) will continue to apply to the Work itself.
 * 6. Trademarks
 *    This license does not grant any rights to use any Licensor's or its 
 *    affiliates' names, logos, or trademarks, except as necessary to 
 *    reproduce the notices described in this license.
 * 7. Limitations
 *    Platform. The Work and any derivative works thereof may only be used, or 
 *    intended for use, with a Broadcom switch integrated circuit.
 *    No Reverse Engineering. You will not use the Work to disassemble, 
 *    reverse engineer, decompile, or attempt to ascertain the underlying 
 *    technology of a Broadcom switch integrated circuit.
 * 8. Termination
 *    If you violate any term of this license, then your rights under this 
 *    license (including the license grants of Sections 2 and 3) will 
 *    terminate immediately.
 * 9. Disclaimer of Warranty
 *    THE WORK IS PROVIDED "AS IS" WITHOUT WARRANTIES OR CONDITIONS OF ANY 
 *    KIND, EITHER EXPRESS OR IMPLIED, INCLUDING WARRANTIES OR CONDITIONS OF 
 *    MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, TITLE OR 
 *    NON-INFRINGEMENT. YOU BEAR THE RISK OF UNDERTAKING ANY ACTIVITIES UNDER 
 *    THIS LICENSE. SOME STATES' CONSUMER LAWS DO NOT ALLOW EXCLUSION OF AN 
 *    IMPLIED WARRANTY, SO THIS DISCLAIMER MAY NOT APPLY TO YOU.
 * 10. Limitation of Liability
 *    EXCEPT AS PROHIBITED BY APPLICABLE LAW, IN NO EVENT AND UNDER NO LEGAL 
 *    THEORY, WHETHER IN TORT (INCLUDING NEGLIGENCE), CONTRACT, OR OTHERWISE 
 *    SHALL ANY LICENSOR BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY DIRECT, 
 *    INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING OUT OF 
 *    OR RELATED TO THIS LICENSE, THE USE OR INABILITY TO USE THE WORK 
 *    (INCLUDING BUT NOT LIMITED TO LOSS OF GOODWILL, BUSINESS INTERRUPTION, 
 *    LOST PROFITS OR DATA, COMPUTER FAILURE OR MALFUNCTION, OR ANY OTHER 
 *    COMMERCIAL DAMAGES OR LOSSES), EVEN IF THE LICENSOR HAS BEEN ADVISED OF 
 *    THE POSSIBILITY OF SUCH DAMAGES.
 */

/*******************************************************************************
 * Includes
 */
#include <shr/shr_debug.h>
#include <shr/shr_error.h>
#include <sal/sal_time.h>
#include <bsl/bsl.h>
#include <bcmltd/chip/bcmltd_id.h>
#include <bcmcfg/bcmcfg_lt.h>
#include <bcmecmp/bcmecmp_dev.h>
#include <bcmecmp/bcmecmp_group.h>
#include <bcmecmp/bcmecmp.h>

/*******************************************************************************
 * Defines
 */
#define BSL_LOG_MODULE BSL_LS_BCMLTX_ECMP

/*!
 * \brief Device ECMP feature initialiation function.
 *
 * Initializes ECMP feature based on the device ECMP resolution mode.
 *
 * \param [in] unit Unit number.
 * \param [in] warm Indicates cold or warm start status.
 *
 * \retval SHR_E_NONE No errors.
 * \retval SHR_E_UNIT Invalid unit number.
 * \retval SHR_E_UNAVAIL When LRD mapping is unavailable for ECMP LTs.
 * \retval SHR_E_CONFIG Invalid ECMP mode is configured in config.yml file.
 */
int
bcmecmp_dev_init(int unit, bool warm)
{
    uint64_t ecmp_mode = BCMECMP_MODE_COUNT; /* Device ECMP mode. */

    SHR_FUNC_ENTER(unit);

    LOG_INFO(BSL_LOG_MODULE,
             (BSL_META_U(unit, "bcmecmp_dev_init.\n")));

    /*
     * Retrieve ECMP_MODE value from ECMP_CONFIG device configuration logical
     * table (BCMCFG).
     */
    SHR_IF_ERR_EXIT
        (bcmcfg_field_get(unit,
                          ECMP_CONFIGt,
                          ECMP_CONFIGt_MODEf,
                          &ecmp_mode));

    /* Update SW ECMP mode variable. */
    switch (ecmp_mode) {
        case BCMECMP_MODE_FULL:
            BCMECMP_MODE(unit) = BCMECMP_MODE_FULL;
            break;
        case BCMECMP_MODE_HIER:
            BCMECMP_MODE(unit) = BCMECMP_MODE_HIER;
            break;
        case BCMECMP_MODE_FAST:
            BCMECMP_MODE(unit) = BCMECMP_MODE_FAST;
            break;
        default:
            SHR_RETURN_VAL_EXIT(SHR_E_CONFIG);
    }

    /* Initialize hardware specific information. */
    if (BCMECMP_FNCALL_CHECK(unit, info_init)) {
        SHR_IF_ERR_VERBOSE_EXIT
            (BCMECMP_FNCALL_EXEC(unit, info_init)(unit, warm));
    } else {
        SHR_RETURN_VAL_EXIT(SHR_E_UNIT);
    }

    /* Allocate memory to store LT Entry information. */
    BCMECMP_ALLOC
        (BCMECMP_LT_ENT_PTR(unit), sizeof(bcmecmp_lt_entry_t),
        "bcmecmpDevLtEntInfo");

    /*
     * Initialize the pseudo-random number generator seed value used for
     * selecting a random member from the members list while performaing
     * resilient hashing load balance operation.
     */
    BCMECMP_RH_RAND_SEED(unit) = (uint32_t)sal_time_usecs();

    exit:
        SHR_FUNC_EXIT();
}

/*!
 * \brief Device ECMP feature cleanup function.
 *
 * Releases resources allocated for ECMP feature.
 *
 * \param [in] unit Unit number.
 * \param [in] warm Indicates cold or warm start status.
 *
 * \retval SHR_E_NONE No errors.
 */
int
bcmecmp_dev_cleanup(int unit, bool warm)
{

    SHR_FUNC_ENTER(unit);

    LOG_INFO(BSL_LOG_MODULE,
             (BSL_META_U(unit, "bcmecmp_dev_cleanup.\n")));

    /* Free memory allocated to store group next-hop members. */
    SHR_IF_ERR_VERBOSE_EXIT(bcmecmp_groups_cleanup(unit));

    /* Cleanup hardware specific information. */
    if (BCMECMP_FNCALL_CHECK(unit, info_cleanup)) {
        SHR_IF_ERR_VERBOSE_EXIT(BCMECMP_FNCALL_EXEC(unit, info_cleanup)(unit));
    } else {
        SHR_RETURN_VAL_EXIT(SHR_E_UNIT);
    }

    /* Free memory allocated for LT Entry buffer. */
    if (BCMECMP_LT_ENT_PTR(unit)) {
        BCMECMP_FREE(BCMECMP_LT_ENT_PTR(unit));
    }
    exit:
        SHR_FUNC_EXIT();
}
